add note for alter shared source #132
Open
+50
−90
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: xxchan <[email protected]>
xxchan
commented
Dec 16, 2024
Comment on lines
-94
to
-97
| ### `FORMAT and ENCODE options` | ||
|
|
||
| At present, combined with the `ALTER SOURCE` command, you can refresh the schema registry of a source by refilling the FORMAT and ENCODE options. For more details about these options, see [FORMAT and ENCODE parameters](/ingestion/format-and-encode-parameters). | ||
|
|
There was a problem hiding this comment.
Although ALTER SOURCE ... FORAMT ENCODE ... is technically supported, I doubt it's usability and should prefer REFRESH SCHEMA instead. So removed from doc.
cc @xiangjinwu
xxchan
commented
Dec 16, 2024
| * You cannot add a primary key column to a source or table in RisingWave. To modify the primary key of a source or table, you need to recreate the table. | ||
| * You cannot remove a column from a source in RisingWave. If you intend to remove a column from a source, you'll need to drop the source and create the source again. | ||
| </Note> | ||
|
|
||
|
|
||
| ### `REFRESH SCHEMA` |
There was a problem hiding this comment.
Moved up, since I think putting ADD COLUMN and REFRESH SCHEMA together is better.
xxchan
commented
Dec 16, 2024
| @@ -126,8 +126,6 @@ Refresh schema | |||
| ALTER SOURCE src_user REFRESH SCHEMA; | |||
| ``` | |||
|
|
|||
| For more details about this example, see our [test file](https://github.com/risingwavelabs/risingwave/blob/994a2831088c9befc71721ed6f2f2d2e35c4d0a9/e2e%5Ftest/schema%5Fregistry/alter%5Fsr.slt). | |||
There was a problem hiding this comment.
I don't think it's a good practice to refer to test file in doc, so removed.
xxchan
commented
Dec 16, 2024
| <Note> | ||
| Shared Kafka source is available since version 2.1. Other sources are unaffected. We plan to gradually upgrade other sources to the be shared as well in the future. | ||
|
|
||
| `ALTER SOURCE [ADD COLUMN | REFRESH SCHEMA]` for shared source is available since version 2.2. |
There was a problem hiding this comment.
New feature added in 2.2. Add note here
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.